<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>UniMRCP: UniMRCP API Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">UniMRCP
   &#160;<span id="projectnumber">1.5.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">UniMRCP API Reference </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><br/>
 </p>
<h1><a class="anchor" id="Introduction"></a>
Introduction</h1>
<p>UniMRCP is an open source project compliant with the IETF RFC6787 (MRCPv2) and RFC4463 (MRCPv1) specifications. The project encapsulates SIP, RTSP, SDP, MRCPv2, and RTP/RTCP stacks and provides integrators with a protocol version consistent interface.</p>
<ul>
<li>Compliance: MRCPv1, MRCPv2 (client and server)</li>
<li>Resources: Synthesizer (TTS), Recognizer (ASR), Verifier (SVI), Recorder</li>
<li>License: Apache 2.0</li>
<li>OS: Cross-platform (Windows, Linux, ...)</li>
<li>Language: C, C++ <br/>
 <br/>
 </li>
</ul>
<h1><a class="anchor" id="_"></a>
Source Tree Structure</h1>
<p><br/>
 </p>
<h2><a class="anchor" id="Libraries"></a>
Libraries</h2>
<ul>
<li>apr-toolkit - Set of utilities built on top of the APR and APR-util libraries (task abstraction, logging, etc).</li>
<li>mpf - Media processing framework.</li>
<li>mrcp - Implementation of MRCP basics (message, parser, resources).</li>
<li>mrcpv2-transport - Implementation of the MRCPv2 transport layer.</li>
<li>mrcp-signaling - Abstract MRCP signaling (session management) interface.</li>
<li>mrcp-engine - Abstract resource engine interface.</li>
<li>mrcp-client - Implementation of an MRCP client stack based on the abstract signaling interface.</li>
<li>mrcp-server - Implementation of an MRCP server stack based on the abstract signaling and engine interfaces.</li>
<li>uni-rtsp - Implementation of a minimal RTSP stack required for MRCPv1.</li>
</ul>
<p><br/>
 </p>
<h2><a class="anchor" id="Modules"></a>
Modules</h2>
<ul>
<li>mrcp-sofiasip - Implementation of the abstract signaling interface using the SofiaSIP library.</li>
<li>mrcp-unirtsp - Implementation of the abstract signaling interface using the UniRTSP library.</li>
</ul>
<p><br/>
 </p>
<h2><a class="anchor" id="Plugins"></a>
Plugins</h2>
<ul>
<li>demo-synth - Implementation of a TTS plugin which simulates synthesis.</li>
<li>demo-recog - Implementation of an ASR plugin which simulates recognition.</li>
<li>demo-verif - Implementation of an SVI plugin which simulates speaker verification.</li>
<li>mrcp-recorder - Implementation of a recorder plugin.</li>
</ul>
<p><br/>
 </p>
<h2><a class="anchor" id="Platforms"></a>
Platforms</h2>
<ul>
<li>libunimrcpclient - The UniMRCP client stack built on top of the underlying mrcp-client library using the mrcp-sofiasip and mrcp-unirtsp modules.</li>
<li>libunimrcpserver - The UniMRCP server stack based on top of the underlying mrcp-server library using the mrcp-sofiasip and mrcp-unirtsp modules.</li>
<li>unimrcpclient - Sample C application based on the UniMRCP client stack.</li>
<li>umc - Sample C++ application based on the UniMRCP client stack.</li>
<li>unimrcpserver - The UniMRCP server application.</li>
</ul>
<p><br/>
 </p>
<h1><a class="anchor" id="Dependencies"></a>
Dependencies</h1>
<ul>
<li><a href="http://apr.apache.org">APR - Apache Portable Runtime Library </a></li>
<li><a href="http://sofia-sip.sourceforge.net">Sofia-SIP - SIP User Agent Library </a></li>
</ul>
<p><br/>
 </p>
<h1><a class="anchor" id="Project"></a>
Links</h1>
<ul>
<li><a href="http://www.unimrcp.org">Website </a></li>
<li><a href="http://www.unimrcp.org/downloads">Downloads </a></li>
<li><a href="http://www.unimrcp.org/documentation">Documentation </a></li>
<li><a href="https://github.com/unispeech/unimrcp">Code Repository </a></li>
<li><a href="https://github.com/unispeech/unimrcp/issues">Issue Tracker </a></li>
<li><a href="http://groups.google.com/group/unimrcp">Discussion Group </a> <br/>
 </li>
</ul>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 22 2017 10:11:48 for UniMRCP by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
